Migrating from the previous driver

The new UI Dynamic driver is a fresh driver on the Crestron Home entity model, not an in-place upgrade. This page explains what you can bring across, what you cannot, and how.

Read this before you remove the old driver

The controls can be brought across automatically. The Crestron Home programming that referenced the old buttons cannot — it must be rewired by hand. Plan the changeover around that, and keep the old driver in place until the new one is wired up.

What carries over, and what does not

Carries over (via the converter)	Does not carry over
Each button's name, states, icons and flags	Crestron Home program bindings to the old buttons
The tile's icon and status text	The old button's event/slot numbers
Your licence key (same product SKU)	—

Why the programming has to be rewired

In Crestron Home, a program is bound to a specific event on a specific driver instance. The new driver is a new instance, so every binding that pointed at the old driver's buttons is now pointing at nothing. Recreating the buttons — which the converter does — does not recreate those bindings. After migrating, open your scenes, schedules and events and re-bind anything that referenced UI Dynamic to the new, named events ("Gate — Open" rather than the old generic slots).

A note on renumbering

The old driver never renumbered its buttons when one was deleted, so a site that had ever deleted a button could end up with gaps or duplicates in the numbering. The new driver closes those gaps — the controls are numbered 1…N in order. The converter shows you the before-and-after so this is not a surprise, but it means a programming action that addressed a control by number may now address a different one. Check the numbers when you rewire.

How to bring the controls across

The migration uses one file — uidynamic-config.json — which the setup app imports. It is the same file used for backup and restore, and for cloning a working configuration from one site to another.

1. Produce the file from your Crestron Home backup. Take a system backup from the processor (the Crestron installer app), then run it through the UI Dynamic migration converter. The converter is a browser tool: you drop the backup in, it finds the old UI Dynamic configuration, and it downloads a uidynamic-config.json. If it reports that it found no configuration, the backup was taken from a processor that did not have the old UI Dynamic driver installed.

   Your backup never leaves your machine

   The conversion runs entirely in your browser. A Crestron Home backup contains the whole system configuration — every other driver's credentials, the network settings, likely user PINs — so it is never uploaded anywhere. Nothing is sent to LCD.

2. Review the preview. The converter shows what it found before you download — the controls, their states, and the old-to-new numbering. Check it looks right.

3. Import it in the setup app. In the new driver's setup app, open Backup & migrate, press Import config, and choose the downloaded file. The app shows an import preview; press Replace, then Save to processor.

4. Rewire the programming. Re-bind your scenes, schedules and events to the new named events, as above.

Backup and restore

The same Backup & migrate tab exports the current configuration to a uidynamic-config.json and imports one back. Use it to keep a backup of a site, or to clone a working tile to another site.

The licence key is not in the config file

The exported file deliberately does not contain the licence key — so it is safe to share and to clone between sites. Enter the licence key on each site through the setup wizard.